home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / kernel / net / netTypes.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-12-19  |  8.3 KB  |  245 lines
  1. /*
  2.  * netTypes.h --
  3.  *
  4.  *    This defines the types and contants for the networking software.
  5.  *
  6.  * Copyright 1985, 1988 Regents of the University of California
  7.  * Permission to use, copy, modify, and distribute this
  8.  * software and its documentation for any purpose and without
  9.  * fee is hereby granted, provided that the above copyright
  10.  * notice appear in all copies.  The University of California
  11.  * makes no representations about the suitability of this
  12.  * software for any purpose.  It is provided "as is" without
  13.  * express or implied warranty.
  14.  *
  15.  *
  16.  * $Header: /cdrom/src/kernel/Cvsroot/kernel/net/netTypes.h,v 1.8 92/06/03 22:48:02 voelker Exp $ SPRITE (Berkeley)
  17.  */
  18.  
  19. #ifndef _NETTYPES
  20. #define _NETTYPES
  21.  
  22. #ifdef KERNEL
  23. #include <netEther.h>
  24. #include <user/net.h>
  25. #include <syncTypes.h>
  26. #include <fs.h>
  27. #else
  28. #include <netEther.h>
  29. #include <net.h>
  30. #include <kernel/syncTypes.h>
  31. #include <kernel/fs.h>
  32. #endif
  33.  
  34. /*
  35.  * This define is used by the net module in maintaining routing
  36.  * information.  It is needed by other modules that maintain state
  37.  * about the various Sprite hosts.
  38.  */
  39.  
  40. #define NET_NUM_SPRITE_HOSTS    200
  41.  
  42. /*
  43.  * Maximum number of network interfaces a host may have.
  44.  */
  45.  
  46. #define NET_MAX_INTERFACES    3
  47.  
  48. /*
  49.  * Constants defining the different types of packets.
  50.  */
  51.  
  52. #define NET_PACKET_UNKNOWN    0x0
  53. #define NET_PACKET_SPRITE    0x1
  54. #define NET_PACKET_ARP        0x2
  55. #define NET_PACKET_RARP        0x3
  56. #define NET_PACKET_DEBUG    0x4
  57. #define NET_PACKET_IP        0x5
  58.  
  59. /*
  60.  * Scatter/gather vector element.  The network output routines take
  61.  * an array of these elements as a specifier for the packet.  This
  62.  * format lets clients of the network module save extra copies because
  63.  * they can leave data objects where they lie.  The done and mutexPtr
  64.  * parts are used to wait for the packet to be truely output.  The
  65.  * mutex is released while the packet is output.
  66.  */
  67.  
  68. typedef struct {
  69.     Address        bufAddr;    /* In - Buffer address */
  70.     int            length;        /* In - Size of the buffer */
  71.     Sync_Semaphore    *mutexPtr;    /* Private to net module.
  72.                      * Used to wait for output. */
  73.     Boolean        done;        /* Out - set when I/O completes */
  74.     void        ((*callBackFunc)());    /* Call-back to say when
  75.                          * we're done sending packet. */
  76.     ClientData        clientData;    /* Client data to pass to call-back. */
  77. } Net_ScatterGather;
  78.  
  79. /*
  80.  * Statistics - the ethernet drivers record the number of occurences
  81.  *    of various events.
  82.  */
  83. typedef struct {
  84.     int    packetsRecvd;        /* # packets received of any type */
  85.     int    packetsSent;        /* # packets sent of any type */
  86.     int    packetsOutput;        /* # packets output of any type */
  87.     int broadRecvd;        /* # broadcast packets received */
  88.     int broadSent;        /* # broadcast packets sent */
  89.     int others;            /* # packets between two other machines */
  90.     int overrunErrors;        /* # packets received with overrun errors. */
  91.     int crcErrors;        /* # packets received with CRC errors. */
  92.     int fcsErrors;        /* # packets received with FCS errors */
  93.     int frameErrors;        /* # packets received with framing errors */
  94.     int rangeErrors;        /* # packets received with range errors */
  95.     int collisions;        /* # of collisions on transmissions */
  96.     int xmitCollisionDrop;    /* # of packets dropped because of too many
  97.                    collisions. */
  98.     int    xmitPacketsDropped;    /* # transmitted packets that are dropped */
  99.     int    recvPacketsDropped;    /* # transmitted packets that are dropped */
  100.     int matches;        /* # of address match packets */
  101.     int recvAvgPacketSize;    /* average size of packets received */
  102.     int recvAvgLargeSize;    /*  ...  of more than 100 bytes */
  103.     int recvAvgSmallSize;    /*  ...  of less than 100 bytes */
  104.     int sentAvgPacketSize;    /* average size of packets sent */
  105.     int sentAvgLargeSize;    /*  ...  of more than 100 bytes */
  106.     int sentAvgSmallSize;    /*  ...  of less than 100 bytes */
  107.     int    bytesSent;        /* Total number of bytes transmitted. */
  108.     int    bytesReceived;        /* Total number of bytes received. */
  109. } Net_EtherStats;
  110.  
  111. /*
  112.  * Statistics for the UltraNet interface. 
  113.  */
  114. typedef struct Net_UltraStats {
  115.     int        packetsSent;        /* Number of packets sent. */
  116.     int        bytesSent;        /* Number of bytes sent. */
  117.     int        sentHistogram[33];    /* Histogram of bytes sent 
  118.                      * (1K buckets). */
  119.     int        packetsReceived;    /* Number of packets received. */
  120.     int        bytesReceived;        /* Number of bytes received. */
  121.     int        receivedHistogram[33];    /* Histogram of bytes received
  122.                      * (1K buckets). */
  123. } Net_UltraStats;
  124.  
  125. /*
  126.  * Statistics for the FDDI interface.
  127.  */
  128.  
  129. /*
  130.  * Granularity at which we keep track of the size of packets sent
  131.  * and received.
  132.  */
  133. #define NET_FDDI_STATS_HISTO_SHIFT      7
  134. #define NET_FDDI_STATS_HISTO_SIZE       128
  135. /*
  136.  * Number of buckets in the packet size histogram.
  137.  */
  138. #define NET_FDDI_STATS_HISTO_NUM  \
  139.           (NET_FDDI_MAX_BYTES >> NET_FDDI_STATS_HISTO_SHIFT)
  140. /*
  141.  * Greatest number of packets that could be reaped in one receive
  142.  * interrupt.  See netDFInt.h:NET_DF_NUM_XMIT_ELEMENTS.
  143.  */
  144. #define NET_FDDI_STATS_RCV_REAPED       32
  145.  
  146. typedef struct Net_FDDIStats {
  147.     int        packetsSent;        /* Number of packets sent. */
  148.     int        bytesSent;            /* Number of bytes sent. */
  149.     int         transmitHistogram[NET_FDDI_STATS_HISTO_NUM];
  150.                                         /* Histogram of packet sizes sent */
  151.     int        packetsReceived;    /* Number of packets received. */
  152.     int        bytesReceived;        /* Number of bytes received. */
  153.     int         receiveHistogram[NET_FDDI_STATS_HISTO_NUM];
  154.                                         /* Histogram of rcved packet sizes */
  155.     int         receiveReaped[NET_FDDI_STATS_RCV_REAPED];
  156.                                         /* Number of packets reaped per
  157.                      * receive interrupt */
  158.     int         xmtPacketsDropped;      /* Packets dropped because 
  159.                      * of lack of transmit buffer space. */
  160.     int         packetsQueued;          /* Number of packets written
  161.                      * to adapter transmit buffers. */
  162. } Net_FDDIStats;
  163.  
  164. /*
  165.  * Statistics in general.
  166.  */
  167.  
  168. typedef struct Net_Stats {
  169.     Net_EtherStats    ether;
  170.     Net_UltraStats    ultra;
  171.     Net_UltraStats    hppi;
  172.     Net_FDDIStats       fddi;
  173. } Net_Stats;
  174.  
  175. /*
  176.  * Structure that defines a network interface.
  177.  */
  178.  
  179. typedef struct Net_Interface {
  180.     char        *name;        /* Name of the interface. */
  181.     int             unit;        /* Unit number of device. */
  182.     Address        ctrlAddr;    /* Address of control register. */
  183.     Boolean        virtual;    /* Is ctrlAddr in kernel VM? */
  184.     int            vector;        /* Interrupt vector generated by 
  185.                      * device. */
  186.  
  187.             /* Initialization routine. */
  188.     ReturnStatus    (*init) _ARGS_((struct Net_Interface *interPtr));
  189.  
  190.             /* Output a packet. */
  191.     ReturnStatus    (*output) _ARGS_((struct Net_Interface *interPtr,
  192.                 Address packetHeader, 
  193.                 Net_ScatterGather *scatterGatherPtr,
  194.                 int scatterGatherLength, Boolean rpc,
  195.                 ReturnStatus *statusPtr));
  196.  
  197.             /* Handle an interrupt. */
  198.     void         (*intr) _ARGS_((struct Net_Interface *interPtr, 
  199.                 Boolean polling));    
  200.  
  201.             /* Reset the interface */
  202.     void         (*reset) _ARGS_ ((struct Net_Interface *interPtr));    
  203.  
  204.             /* Perform ioctls on interface. */
  205.     ReturnStatus    (*ioctl) _ARGS_((struct Net_Interface *interPtr,
  206.                 Fs_IOCParam *ioctlPtr, Fs_IOReply *replyPtr));    
  207.  
  208.             /* Get performance statistics. */
  209.     ReturnStatus    (*getStats) _ARGS_((struct Net_Interface *interPtr,
  210.                 Net_Stats *statPtr));    
  211.  
  212.     int            number;        /* Interface number. */
  213.     Net_NetworkType    netType;    /* Type of interface. See below. */
  214.     int            flags;        /* Status flags. See below. */
  215.     Sync_Semaphore    syncOutputMutex;/* Used to wait for packets
  216.                      * to be output. */
  217.     Sync_Semaphore    mutex;        /* Protects network interface board
  218.                      * and related data structures. */
  219.     int            maxBytes;    /* Maximum transfer unit 
  220.                      * (packet size) */
  221.     int            minBytes;    /* Minimum transfer unit. */
  222.  
  223.             /* Packet handler for network device driver. */
  224.     void        (*packetProc) _ARGS_((struct Net_Interface *interPtr,
  225.                 int packetLength, Address packetPtr));
  226.  
  227.     ClientData        interfaceData;    /* Place for the interface routines
  228.                      * store store stuff. */
  229.     ClientData        devNetData;    /* Place for the network device
  230.                      * driver to store stuff. */
  231.     Net_Address        netAddress[NET_MAX_PROTOCOLS];
  232.     Net_Address        broadcastAddress; /* Broadcast address for this
  233.                        * interface. */
  234. } Net_Interface;
  235.  
  236. /*
  237.  * Flag values for Net_Interface.
  238.  */
  239.  
  240. #define NET_IFLAGS_RUNNING    0x1    /* The interface is active. */
  241. #define NET_IFLAGS_BROADCAST    0x2    /* Interface supports broadcast. */
  242.  
  243.  
  244. #endif /* _NETTYPES */
  245.